Add {IoSlice, IoSliceMut}::advance #62987
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
Thanks for the PR! As a convenience function though I would imagine that wouldn't this be more useful if defined on something like |
I agree, that is what I need for rust-lang/futures-rs#1741 as well. I'm fine with changing it. But where would I put the code for such a change? In the |
|
Perhaps something like: impl IoVec<'_> {
pub fn advance(slice: &mut [IoVec]) { /* ... */ }
}
impl IoVecMut<'_> {
pub fn advance(slice: &mut [IoVecMut]) { /* ... */ }
}or something like that? |
|
Looks good, I'll try to update the pr tomorrow. |
Thomasdezeeuw
commented
Jul 31, 2019
src/libstd/io/mod.rs
Outdated
| /// | ||
| /// # Notes | ||
| /// | ||
| /// Elements in the slice may be modified. |
There was a problem hiding this comment.
This might need expanding.
There was a problem hiding this comment.
Yeah I'd recommend going into detail here and explaining how the vector elements of the slice may be modified to adjust the size as noted by advance
There was a problem hiding this comment.
What do you think of what I've added?
|
I've addressed all comments and updated the API to return the truncated slice. |
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
alexcrichton
reviewed
Aug 1, 2019
| /// | ||
| /// Elements in the slice may be modified. | ||
| /// | ||
| /// # Examples |
There was a problem hiding this comment.
The documentation here I think may also want to mention that this API panics if you advance beyond the cumulative size of all buffers.
There was a problem hiding this comment.
But it doesn't panic if you go beyond the cumulative size, see the io_slice_advance_beyond_total_length test.
src/libstd/io/mod.rs
Outdated
| /// | ||
| /// # Notes | ||
| /// | ||
| /// Elements in the slice may be modified. |
There was a problem hiding this comment.
Yeah I'd recommend going into detail here and explaining how the vector elements of the slice may be modified to adjust the size as noted by advance
Thomasdezeeuw
commented
Aug 1, 2019
| /// ][..]; | ||
| /// | ||
| /// // Mark 10 bytes as read. | ||
| /// bufs = IoSliceMut::advance(mem::replace(&mut bufs, &mut []), 10); |
There was a problem hiding this comment.
I'm not too fond of this mem::replace dance we have to do.
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
|
The commits have become a bit messy, I'll squash them before merging once the review is complete. |
|
Ok everything looks great to me, thanks! If you want to do some cleanup feel free! @bors: delegate+ |
|
✌️ @Thomasdezeeuw can now approve this pull request |
|
This is ready now, I've squashed the commits and rebased on master. |
|
Hope this works. @bors r+ |
|
📌 Commit dad56c3 has been approved by |
bors
added
S-waiting-on-bors
|
⌛ Testing commit dad56c3 with merge ebaa05e81052cc5f04d68880275ba073021d5f9a... |
Centril
added a commit
to Centril/rust
that referenced
this pull request
Aug 5, 2019
…omasdezeeuw
Add {IoSlice, IoSliceMut}::advance
API inspired by the [`Buf::advance`](https://docs.rs/bytes/0.4.12/bytes/trait.Buf.html#tymethod.advance) method found in the [bytes](https://docs.rs/bytes) crate.
Closes rust-lang#62726.
Centril
reviewed
Aug 5, 2019
| panic!("advancing IoSliceMut beyond its length"); | ||
| } | ||
|
|
||
| unsafe { |
There was a problem hiding this comment.
Could we always uphold the minimum standard of having comments on all unsafe { blocks?
I think that's something you should be able to expect of something so central as the standard library.
|
@bors retry rolled up. |
|
⌛ Testing commit dad56c3 with merge 1828a3f06b20e9c99e443d2a99fd424016735a05... |
|
@bors retry yielding to r0llup. |
|
⌛ Testing commit dad56c3 with merge 015346c142811b881b28c5e81c1b27e59fe286d8... |
|
@bors retry yielding to r0llup. |
bors
added a commit
that referenced
this pull request
Aug 6, 2019
Add {IoSlice, IoSliceMut}::advance
API inspired by the [`Buf::advance`](https://docs.rs/bytes/0.4.12/bytes/trait.Buf.html#tymethod.advance) method found in the [bytes](https://docs.rs/bytes) crate.
Closes #62726.
|
☀️ Test successful - checks-azure |
This was referenced Aug 6, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
API inspired by the
Buf::advancemethod found in the bytes crate.Closes #62726.